AutoLISP Tutorial

_$ prompt, in Console window

, as AutoLISP comment code [1], [2]

.dcl file extension [1], [2]

.prj file extension

.prv file extension

.vlx file extension

), as AutoLISP comment code [1], [2]

*Last-Value* variable [1], [2]

*lostAssociativity* variable [1], [2]

*ModelSpace* variable [1], [3], [5], [6]

*polyToChange* variable [1], [2], [3]

*reactorsToRemove* variable

*Safe-to-Delete* function

//, as DCL comment code

> button (Project Properties dialog box)

converting 3D points to

converting lists of, to lists of lists

at specified angle and distance from a point

converting lists of, to list of lists

converting to 2D points

3dPoint->2dPoint function

A

action_tile function

actions, assigning to tiles

ActiveX functions

command function and [1], [2]

entity creation. See object creation

entmake function and [1], [2]

global variables and

loading ActiveX [1], [2]

model space pointer and [1], [3]

object creation using [1], [2], [3], [4], [5], [6], [7], [8], [9]

object model structure for

passing parameters to

radio button for

reactors and [1], [2], [3]

real numbers required by

return values from [1], [2]

translating VBA syntax into ActiveX calls

constructing from a list of points [1], [2]

vla- prefix and

Add Watch button (Watch window)

Add Watch command (Debug menu)

files to projects

reactor callback functions

See also assigning

variables to Watch window [1], [3]

analyzing. See inspecting

converting degrees to radians [1], [3]

drawing path at any angle

anonymous functions

append function [1], [3]

applications, creating [1], [2]

arguments. See parameter passing

arrays of polyline points, constructing

arrow (>) button (Project Properties dialog box)

assigning [1], [2], [3]

actions to tiles

See also adding

association lists (assoc lists) [1], [2]

getPointInput function [1], [2], [3], [4], [6]

inspecting (parsing)

key values [1], [2], [3]

passing to functions

associativity between tiles and path, breaking [1], [2], [4], [5]

attaching [1], [2], [3]

See also adding

crashing [1], [2], [3]

emulating in AutoLISP programs

entities. See entities

minimized window, gpath prompts and

reactors and. See reactors

waiting for control to return from

checking [1], [2]

color syntax coding [1], [2]

commenting [1], [2]

debugging. See debugging

revising [1], [3]

selecting blocks of

testing [1], [2]

automatic garbage collection

automatic word completion [1], [2]

Automation objects

B

blocks of code, selecting

ActiveX and [1], [2]

angle of path and [1], [2]

dialog box creation for

dialog box defaults for

erasing, reactors and [1], [2], [3], [5], [7]

defining radio buttons for specifying

drawing specified style

reactors and [1], [2], [3], [4]

GRIP commands and [1], [4]

grip mode of STRETCH command and [1], [2], [3], [4]

reactors and [1], [2], [3], [4]

drawOutline function

determining [1], [3]

finding moved points

finding points in lists

reactors and moving [1], [2], [3], [4]

See also points

variant array of [1], [2]

BoundaryData variable [1], [3]

boxed_radio_column DCL directive

braces ({}), in DCL

breakpoints [1], [2]

clearing individual [1], [2]

Debug toolbar and

stepping through code from

Btm button (Project Properties dialog box)

Build Output window

application building and

syntax checking and

building. See creating

assigning actions for dialog boxes

creating for dialog boxes

Debug toolbar [1], [4], [6]

Project Properties dialog box

VLISP toolbar [1], [3], [4]

C

GPath function [1], [3], [5], [6], [8], [10], [11], [12]

Calculate-and-Draw-Tiles function [1], [3], [4]

Calculate-Draw-TileRow function [1], [2]

callback functions

ActiveX and [1], [3], [4]

adding functionality to [1], [2]

editor reactors and [1], [2], [3], [4], [6], [7]

object reactors and [1], [3], [4], [5], [7], [8], [9]

planning and designing [1], [3]

See also specific callback functions [1], [2]

defining in DCL

procedure when user presses [1], [2]

case sensitivity, Help system and

GRIP commands and [1], [4]

grip mode of STRETCH command and [1], [2], [3], [4]

reactors and [1], [2], [3], [4]

See also clearing

value of variables while program is running

Check Text in Editor command (Tools menu)

checking code. See syntax checking

circles. See tiles (garden path)

clean-all-reactors function

CleanReactors function

Clear All Breakpoints command (Debug menu)

all breakpoints

individual breakpoints [1], [2]

See also detaching

command function

ActiveX and [1], [2]

entity creation by

entity creation via [1], [2]

radio button for

reactors and [1], [2]

command line, in AutoCAD

command-ended function. See gp

command-ended function

command-will-start function [1], [2], [4]

entering in Console window

See also specific commands

AutoLISP [1], [2]

comparing floating point values

Complete Word by Apropos feature

Complete Word by Match command (Search menu)

completing words automatically [1], [2]

concatenating lists

entering commands in

history command

constructing. See creating

Continue button (Debug toolbar)

2D point lists to list of lists

3D point lists to list of lists

3D points to 2D points

degrees to radians [1], [3]

lists of points to variant arrays [1], [2]

real numbers to strings

strings to real numbers

corner points. See boundaries, vertices

crashing AutoCAD, reactors and [1], [2], [3]

creating [1], [2], [3]

applications [1], [2]

boundaries. See boundaries

buttons in dialog boxes

dialog box default values

entities (objects). See objects, creating

files [1], [3], [4]

See also adding

tiles. See tiles (garden path)

variant arrays of polyline points [1], [2]

curly braces ({}), in DCL

cursor, breakpoints and

D

database reactors

DCL (dialog control language)

comment code for

defining dialog boxes

loading files [1], [2]

previewing files

See also dialog boxes

sources of information on

syntax coloring scheme and

unloading files

VLX applications and

Add Watch command

Clear All Breakpoints command

Watch Last Evaluation command

breakpoints and

Continue button

Step Into button [1], [2], [3]

Step Out button [1], [2]

Step Over button

stepping through code and [1], [2], [3]

Toggle Breakpoint button [1], [2]

debugging [1], [2]

association lists and [1], [2]

breakpoints and [1], [2]

changing value of variables while program is running

global variables and [1], [3], [4]

local variables and [1], [2], [3]

stepping through code [1], [2]

watching variables [1], [3]

defaults, dialog box values [1], [2], [3]

defining [1], [2], [3]

functions. See defun function statement

See also adding

defun function statement

ActiveX loading and

global variable assignment and

stubbed-out functions and

variable declaration and

Degrees->Radians function [1], [3], [5]

deleting. See clearing

programs [1], [2]

reactor callback functions [1], [3]

See also planning

detaching [1], [2], [3], [4], [5]

See also attaching

dialog boxes [1], [2]

assigning actions to tiles

default values [1], [2], [3]

interfacing with, from AutoLISP code [1], [2]

loading [1], [2]

See also specific dialog boxes

VLX applications and

dialog control language (DCL). See DCL (dialog control language)

DialogInput function. See gp

getDialogInput function

dialogLoaded variable [1], [2]

dialogShow variable [1], [2], [3]

working directory

displaying program output

document reactors

done_dialog function

double slash (//), as DCL comment code

doubles, arrays of [1], [2]

drawing. See creating

drawOutline function. See gp

drawOutline function

E

Edit menu, Parentheses Matching command

editor reactors

callback functions and [1], [2], [3], [4], [5], [6]

described [1], [2], [4], [5]

where to attach

EndPt variable [1], [3], [5]

Enter Expression to Watch dialog box

entget function, entmake function vs.

entities. See objects

entmake function

ActiveX and [1], [2], [3]

entget function vs.

entity creation

radio button for

entries beginning with get, vla-get, and vlax-get

erase-tiles function

erasing [1], [2], [3], [4], [5]

boundaries and tiles, reactors and [1], [2], [3], [5], [7]

See also clearing

tiles and redrawing when boundaries change, reactors and [1], [2], [3], [4], [5]

color coding and [1], [2]

See also debugging

error messages, displaying

executing. See running

programs quietly

stepping through code

F

Make Application command

New File command

Save All command

Save As command

adding to projects

creating application [1], [2]

DCL files [1], [2]

program files [1], [2]

project files [1], [2]

managing through projects

organizing contents of source code

Find command (Search menu)

finding. See searching

FindMovedPoint function

FindPointInList function

floating point values

See also real numbers

Format AutoLISP in Editor command (Tools menu)

forward slashes (//), as DCL comment code

callback. See callback functions

checking [1], [2]

commenting [1], [2]

debugging. See debugging

defining. See defun function statement

exiting quietly

help for [1], [2]

finding and completing names

organizing within source code files

passing parameters to. See parameter passing

return values. See return values

revising [1], [3]

on individual elements in lists [1], [3]

See also specific functions

testing [1], [2]

variables. See variables

G

garbage collection, automatic

illustrated [1], [2]

See also boundaries

getDialogInput function

width of [1], [2]

gardenpath.prv file

gardenpath.vlx file [1], [3]

getDialogInput function. See gp

getDialogInput function [1], [2]

getdist function

getpoint function

getPointInput function. See gp

getPointInput function

global variables [1], [2]

ActiveX entity creation and

debugging and [1], [2], [3], [4]

defun function statement and

model space and [1], [2]

reactors and [1], [2], [3], [5], [7], [8]

See also specific global variables

goals, defining

Calculate-and-Draw-Tiles function [1], [3], [4]

Calculate-Draw-TileRow function [1], [2]

clean-all-reactors function

command-ended function [1], [2], [3], [4], [5], [6]

code for [1], [2]

designing [1], [3]

outline-changed function and

outline-erased function and

multiple entity types and

multiple reactors and

command-will-start function [1], [2], [4]

drawOutline function [1], [2], [3]

ActiveX and [1], [2]

angle of path and

boundary line style selection code for

passing parameters to [1], [2]

pointer to model space [1], [3]

polyline perimeter point list

polyline pointer

See also boundaries

variant array of [1], [2]

erase-tiles function

FindMovedPoint function

FindPointInList function

getDialogInput function

adding dialog box to [1], [2]

purpose of [1], [2]

getPointInput function [1], [3], [4]

breakpoints and [1], [2]

local variables in [1], [2]

purpose of [1], [2]

association lists of [1], [2], [3], [4], [6]

regular lists of

storing in variables

stepping through [1], [2]

watching variables [1], [2]

list->variantArray function

outline-changed function [1], [3]

outline-erased function [1], [3]

pointEqual function

recalcPolyCorners function

RedefinePolyBorder function

Safe-Delete function

zeroSmallNum function

gp_dialogResults variable

gp_PathData variable

drawOutline function and [1], [2]

getDialogInput function and [1], [2]

reactors and [1], [3]

watching value of

gp_spac variable

gp_trad variable

gpath command [1], [2], [3]

GPath function. See C

gpdialog.dcl file [1], [2], [3]

gpdraw.lsp file [1], [2], [3], [4], [5], [6]

gpmain.lsp file

position in project files

return values and

using the supplied

gppoly.lsp [1], [2]

gpreact.lsp file [1], [2], [3], [4], [5]

GRIP commands, reactors and [1], [4]

grip mode of STRETCH command, reactors and [1], [2], [3], [4]

H

HalfWidth variable [1], [3], [4]

Help button (VLISP toolbar)

help, for functions [1], [3]

highlighting blocks of code

history command

I

I-beam cursor, in Debug toolbar

initializing dialog boxes

getDialog Input function

Inspect command (View menu)

Add Watch command

Inspect command

association lists

integers, ActiveX functions and

Interface Tools command (Tools menu)

K

AutoCAD and [1], [2]

in associated lists [1], [3], [4]

L

lambda function

lightweight boundary lines. See boundaries, line styles

line styles. See boundaries, line styles

linker reactors

list->variant Array function

association. See association lists

comparing lists of points

converting 2D point lists to list of

converting 3D point lists to list of

converting lists of points to variant arrays

executing functions on individual elements in

finding points in

of return values

association lists. See association lists

passing to functions

association lists

testing for null values in

Load Text in Editor command (Tools menu)

load_dialog function

ActiveX [1], [2]

DCL files [1], [2]

functions [1], [3], [4]

programs [1], [2]

project files [1], [2]

See also unloading

selected code [1], [2], [4]

local variables [1], [2]

declaring [1], [2]

nil return values and

See also specific local variables

watching [1], [3]

M

Make Application command (File menu)

managing files through projects

mapcar function [1], [3], [4]

matching parentheses

memory, local and global variables and

messages, displaying program

minimized windows

AutoCAD window, gpath prompts and

VLISP, accessing

global variables and [1], [4]

obtaining a pointer to [1], [3]

obtaining a pointer to global variables

model space and

modifying. See changing

boundaries. See boundaries, modifying

N

naming functions

finding and completing names

New File command (File menu)

New Project command (Project menu)

new_dialog function

NewReactorData parameter

nil return values [1], [2]

nonlinear reactor sequences

null values, testing for, in lists

ActiveX functions and

comparing floating point values

converting real numbers to strings

converting strings to real numbers

integer vs. real

passing to functions

O

object reactors

callback functions and [1], [2], [4]

described [1], [2]

where to attach

ObjectARX applications, reactors and [1], [2]

ObjectCreationFunction variable

ObjectCreationStyle parameter [1], [2], [3]

ObjectCreationStyle variable

ActiveX object model structure

Automation objects

with ActiveX [1], [2], [3], [4], [5], [6], [7], [8], [9]

with command function [1], [2]

with entmake function [1], [2], [3]

handling multiple types of

reactors and. See object reactors

returning entity data to AutoLISP

objects. See entities (objects)

assigning actions to

defining in DCL

procedure when user presses [1], [2]

Open Project command (Project menu)

project files [1], [3]

See also loading

organizing functions within source code files

outline-changed function [1], [3], [4]

outline-erased function [1], [2], [5]

outline. See also gp

drawOutline function

displaying program

drawOutline function

vla-put functions

P

parameter passing [1], [2]

association lists

declaring variables as both parameters and local variables

numbers [1], [2]

See also specific parameters

Parentheses Matching command (Edit menu)

parsing association lists

passing parameters

ActiveX functions

passing parameters. See parameter passing

path. See garden path

PathAngle variable [1], [2]

PathLength variable

pausing program execution. See breakpoints

reactor callback functions [1], [3]

See also designing

utility functions [1], [2]

pline variable [1], [3], [4]

to model space [1], [3]

PointInput function. See gp

getPointInput function

3D points at specified angle and distance from a point

converting 3D points to 2D points

converting lists of 2D/3D points to list of lists

determining corner [1], [3]

finding in lists

reactors and moving [1], [2], [3], [4]

variant array of [1], [2]

polar function [1], [2]

polyline borders. See boundaries

PolylineList variable

polyPoints variable

previewing dialog boxes

programs. See code

New Project command

Open Project command

Project Properties button (project window) [1], [2]

Project Properties dialog box

project window [1], [3]

adding files to

loading and running all files in

_$ prompt in Console window

displaying program

minimized AutoCAD window and

Q

R

radians, converting degrees to [1], [3]

in dialog boxes

See also buttons

radio_column DCL directive

radius of tiles

default [1], [2]

ActiveX and [1], [2], [3]

AutoLISP applications and

callback functions

ActiveX and [1], [2], [3]

adding functionality to [1], [2]

editor reactors and [1], [2], [3], [4], [6], [8]

object reactors and [1], [2], [3], [4], [5], [6], [7]

planning and designing [1], [2], [3]

See also specific callback functions

crashing AutoCAD and [1], [2], [3], [4]

callback functions and [1], [3], [4]

described [1], [2], [5], [6]

where to attach

event selection

for boundaries [1], [2], [3], [4]

global variables and [1], [2], [4], [5], [6]

GRIP commands and

grip mode of STRETCH command and [1], [2], [3], [4]

multiple entity types and

non-linear sequences of

callback functions and [1], [2], [3], [4], [5], [6], [7]

described [1], [2]

where to attach

ObjectARX applications and [1], [2]

planning the overall process [1], [2]

removing [1], [2]

returning to VLISP from AutoCAD and

storing data with [1], [2]

testing [1], [2]

tiles and [1], [2], [3], [5], [6], [7]

trace sheets for [1], [3], [4]

transient versus persistent

types of [1], [3]

ActiveX functions and

converting real numbers to strings [1], [2]

floating point values

recalcPolyCorners function

RedefinePolyBorder function

reference works. See resources

removing [1], [2], [3], [4], [5]

reactors [1], [2]

See also clearing

Reset button (Debug toolbar)

LISP and AutoLISP

ActiveX functions

drawOutline function [1], [3]

getDialogInput function

getPointInput function. See gp

getPointInput function, return values

association. See association lists

nil return [1], [2]

storing in variables

revising code [1], [3], [4]

rotating boundaries. See boundaries, modifying

rows. See tiles (garden path)

rowStartPoint variable

and stepping through [1], [2]

breakpoints with [1], [2]

on individual elements in lists [1], [2]

garden path example

programs [1], [3]

S

Safe-Delete function

Save All command (File menu)

Save As command (File menu)

scaling boundaries. See boundaries, modifying

Complete Word by Match command

for closest match to complete a word

for moved points

for points in a list [1], [2]

See also key values

Select Window button (VLISP toolbar)

semicolon ( [1], [2]

set_tile function

setting. See adding

slashes (//), as DCL comment code

organizing functions within files of

spacing of rows

spacing of tiles

default [1], [2]

specific windows

start_dialog function [1], [2]

See also creating

StartPt variable [1], [3], [4]

Step Indicator (Debug toolbar)

Step Into button (Debug toolbar) [1], [2], [3], [4]

Step Out button (Debug toolbar) [1], [2]

Step Over button (Debug menu)

Step Over button (Debug toolbar) [1], [2]

stepping through code [1], [2]

Debug toolbar and [1], [2], [3]

exiting [1], [2]

from breakpoints [1], [4], [5]

watching variables while

data with reactors [1], [2]

return values in variables

stretching boundaries, reactors and [1], [3], [4], [5]

converting real numbers to

converting to real numbers

stubbed-out functions

suspending program execution. See breakpoints

syntax checking

color coding and [1], [2]

T

reactor code [1], [2]

See also debugging

tileList variable

tiles (dialog box component)

tiles (garden path)

erasing when boundary is erased [1], [2], [3], [5], [7]

illustrated [1], [2]

radius and tile spacing

default [1], [2]

reactors and [1], [2], [3], [5], [6]

redrawing when boundary is modified [1], [2], [3], [4], [5]

row-offset pattern [1], [2], [3]

Toggle Breakpoint button (Debug toolbar) [1], [3]

See also Debug toolbar

Check Text in Editor command (Tools menu)

Format AutoLISP in Editor command (Tools menu)

Interface Tools command

Load Text in Editor command

Top button (Project Properties dialog box)

trace sheets, reactor [1], [3], [4]

true return value

U

unload_dialog function [1], [2]

utility functions

3dPoint->2dPoint

list->variantArray function

xyList->ListOfPoints

xyzList->ListOfPoints

utils.lsp file [1], [3], [4], [5], [6]

V

for radio buttons in DCL

breakpoints and

changing value while program is running

passing to functions

storing return values in

variants (ActiveX)

constructing arrays of polyline points [1], [2]

VBA syntax, translating into AutoLISP

vertices. See boundaries, vertices

Inspect command

Visual LISP Tutorial [1], [2]

Visual LISP. See entries beginning with VLISP

vl-load-com function

vla-addLightweightPolyline function [1], [3], [4]

vla-get functions

vla-get-ActiveDocument function

vla-get-ModelSpace function

vla-put functions

vla-put-closed function

vlax-get-Acad-Object function

vlax-make-safearray function

vlax-make-variant function

vlax-safearray-fill function

VLISP development environment

accessing minimized windows

reactors and returning from AutoCAD to

VLISP pointer in

waiting for control to return from AutoCAD

Debug command. See Debug menu

Edit command. See Edit menu

File command. See File menu

Project command. See Project menu

Search command. See Search menu

Tools command. See Tools menu

View command. See View menu

Select Window button

vlr-commandEnded events [1], [2]

vlr-commandWillStart events [1], [2]

vlr-erased event

vlr-modified event [1], [2]

vlr-object-reactor function

VLX applications [1], [2]

W

Watch command (Debug menu), Add

Watch Last Evaluation command (Debug menu)

Add Watch button in

Add Watch command and

Watch Last Evaluation command and

watching variables [1], [2], [4]

adding variables to Watch window [1], [3]

Debug toolbar and

while stepping through code

width of path [1], [2]

Window command (VLISP menu)

windows. See minimized windows

words, completing automatically [1], [2]

working directory

X

xyList->ListOfPoints function

xyzList->ListOfPoints function